Obtains the original countdown duration, the time remaining, and the item selection to be simulated for a specified modal dialog box.

OSStatus GetDialogTimeout (
    DialogPtr inDialog, 
    SInt16 *outButtonToPress, 
    UInt32 *outSecondsToWait, 
    UInt32 *outSecondsRemaining
);

inDialog

A pointer to the dialog box to be examined.

outButtonToPress

On input, a pointer to a signed 16-bit integer. On return, a value representing the number within the item list of the item that is to be selected. You may pass NULL for the outButtonToPress parameter if you do not desire this information.

outSecondsToWait

On input, a pointer to an unsigned 32-bit integer. On return, a value specifying the number of seconds that were originally set to elapse before the Dialog Manager simulates an item selection. You may pass NULL for the outSecondsToWait parameter if you do not desire this information.

outSecondsRemaining

On input, a pointer to an unsigned 32-bit integer. On return, a value specifying the number of seconds remaining before the Dialog Manager simulates an item selection. You may pass NULL for the outSecondsRemaining parameter if you do not desire this information.

function result

A result code.

DISCUSSION

Also see the function SetDialogTimeout.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when DialogsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by DialogsLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)